Vault Add Credit Card

Creates a new credit card profile, and generates a unique data key which can be obtained from the Receipt object.

This data key is the profile identifier that all future financial Vault transactions will use to associate with the saved information

Canada Code Sample

//Request Format:

res_add_cc_cof, order_id, cust_id, phone, email, note, pan, exp_date, crypt_type, issuer_id

//Sample Request:

res_add_cc_cof,mjr-res-add-210510-251-1,moneris,phone,email,note,4242424242424242,1111,7,139X3130ASCXAS9

//Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved, reserved

//Sample Response:

mjr-res-add-210510-251-1,null,001,null,null,14:52:49,2010-05-21,null,true,Successfully registered CC details.,null,null,null,false,,,we3u5tak7ce4UPiy1xRnDqqju,cc,moneris,phone,email,note,4242***4242,1111,7,,,,,

Vault Add Credit Card mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Credit card number String 20-character alphanumeric pan Most credit card numbers today are 16 digits, but some 13-digit numbers are still accepted by some issuers. This field has been intentionally expanded to 20 digits in consideration for future expansion and potential support of private label card ranges.
Expiry Date String 4-character alphanumeric (YYMM format) expdate Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character numeric crypt_type

Describes the category of e-commerce transaction being processed. Allowable values are:


  • 1 - Mail Order / Telephone Order—Single
  • 2 - Mail Order / Telephone Order—Recurring
  • 3 - Mail Order / Telephone Order—Instalment
  • 4 - Mail Order / Telephone Order—Unknown classification
  • 5 - Authenticated e-commerce transaction (VBV)
  • 6 - Non-authenticated e-commerce transaction (VBV)
  • 7 - SSL-enabled merchant

In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows:


if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6
if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7
if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7
if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7
Issuer ID

NOTE:This variable is required for all merchant- intiated transactions following the first one; upon sending the first transaction, the Issuer ID value is received in the transaction response and then used in subsequent transaction requests (Issuer ID does not apply for Discover or Union Pay).		 String 15-character alphanumeric

Variable length		 N/A Unique identifier for the cardholder's stored credentials

Sent back in the response from the card brand when processing a Credential on File transaction

If the cardholder's credentials are being stored for the first time, and the issuer id was returned in the response, you must save the Issuer ID on your system to use in MIT subsequent Credential on File transactions

The IssuerID must be saved to your systems when returned from Moneris Gateway in the response data, regardless if the value was received or not. As a best practice, if the IssuerID is not returned and you received N/A instead, store it and send it in the subsequent transaction.

Vault Add Credit Card Optional Values

NOTE: Values for optional fields do not have to be sent in a transaction request, but the positional structure of CSV still requires the comma delimiters between each field regardless if a value is sent for the given field or not.

Value Type Limits Variable Description
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number and so on.

This field is searchable from the Moneris Merchant Resource Centre.
Phone Number String 30-character alphanumeric phone Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric note This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile.
Email address String 30-character alphanumeric email Email address of the customer. Can be sent in when creating or updating a Vault profile.

Vault Response Fields

Value Limits Variable Description
Data Key 25-character alphanumeric DataKey This field is created when a profile is created and a token is returned.
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric avs_street_name Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric avs_street_zipcode Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

Vault Update Credit Card

Updates an existing Vault profile (referencing the profile's unique data key) with cardholder information.

Information contained within a credit card profile is updated as indicated by the submitted fields; if any field representing an item of cardholder information is not sent in this request, that item will remain unchanged in the profile.

If the Vault profile is being updated with a new credit card number, then you first need to send a Purchase, Pre-Authorization or Card Verification transaction, with the Credential on File Info object included, before performing Vault Update Credit Card. If the credit card number is not one of the profile items being updated, this step is not required.

Things to consider:

  • To update a specific element in the profile, set that element using the corresponding set method
  • When updating a credit card number, first send a Purchase, Pre-Authorization, or Card Verification with the Credential on File Info object before sending this transaction; send the issuer ID received in the response in the subsequent Vault Update Credit Card request
  • If the credit card number is not one of the profile items being updated, the Credential on File info object is not required

Canada Code Sample

Request Format:

res_update_cc,order_id,data_key,cust_id,phone,email,note,pan,exp_date,crypt_type

Sample Request:

res_update_cc,mjr-res-update-210510-251-1,moneris,phone,email,note,4242424242424242,1111,7

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

Sample Response:

mjr-res-update-210510-251-1,null,001,null,null,14:52:49,2010-05-21,null,true,Successfully registered CC details.,null,null,null,false,,,we3u5tak7ce4UPiy1xRnDqqju,cc,moneris,phone,email,note,4242***4242,1111,7,, ,,

Vault Update Credit Card mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Data key String 25-character alphanumeric data_key The data key is generated by Moneris, and is returned to the merchant when the profile is first registered.

Vault Update Credit Card optional values

NOTE: Values for optional fields do not have to be sent in a transaction request, but the positional structure of CSV still requires the comma delimiters between each field regardless if a value is sent for the given field or not.

Value Type Limits Set method Description
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number and so on.

This field is searchable from the Moneris Merchant Resource Centre.
Email address Phone Number 30-character alphanumeric email Email address of the customer. Can be sent in when creating or updating a Vault profile.
Phone Number String 30-character alphanumeric phone Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric note This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile.
Credit card number String 20-character alphanumeric pan Most credit card numbers today are 16 digits, but some 13-digit numbers are still accepted by some issuers. This field has been intentionally expanded to 20 digits in consideration for future expansion and potential support of private label card ranges.
Expiry Date String 4-character alphanumeric (YYMM format) expdate Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character numeric crypt_type

Describes the category of e-commerce transaction being processed. Allowable values are:


  • 1 - Mail Order / Telephone Order—Single
  • 2 - Mail Order / Telephone Order—Recurring
  • 3 - Mail Order / Telephone Order—Instalment
  • 4 - Mail Order / Telephone Order—Unknown classification
  • 5 - Authenticated e-commerce transaction (VBV)
  • 6 - Non-authenticated e-commerce transaction (VBV)
  • 7 - SSL-enabled merchant

In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows:


if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6
if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7
if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7
if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7

Vault Response Fields

Value Limits Variable Description
Data Key 25-character alphanumeric DataKey This field is created when a profile is created and a token is returned.
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric avs_street_name Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric avs_street_zipcode Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.

Vault Update Credit Card with Credential on File

Use this Credential on File transaction only when updating the credit card number (pan); for all other situations, use the basic Vault Update Credit Card transaction instead.

Canada Code Sample

//Request Format:

res_update_cc_cof, order_id, data_key, cust_id, phone, email, note, pan, exp_date, crypt_type, issuer_id
 
//Sample Request:

res_update_cc_cof,mjr-res-add-210510-251-1,we3u5tak7ce4UPiy1xRnDqqju,moneris,phone,email,note,4242424242424242,1111,7,139X3130ASCXAS9

//Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate,reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved,
reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date,crypt_type, reserved, reserved, reserved, reserved, reserved

//Sample Response:

mjr-res-add-210510-251-1,null,001,null,null,14:52:49,2010-05-21,null,true,Successfully registered CC details.,null,null,null,false,,,we3u5tak7ce4UPiy1xRnDqqju,cc,moneris,phone,email,note,4242***4242,1111,7,,,,,

Vault Update Credit Card with Credential on File mandatory values

Value Type Limits Variable Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Data key String 25-character alphanumeric data_key The data key is generated by Moneris, and is returned to the merchant when the profile is first registered.
Issuer ID
NOTE: This variable is required for all merchant-initiated transactions following the first one; upon sending the first transaction, the Issuer ID value is received in the transaction response and then used in subsequent transaction requests (Issuer ID does not apply for Discover or Union Pay). 		String 15-character alphanumeric
Variable length 		Issuer_id Unique identifier for the cardholder's stored credentials

Sent back in the response from the card brand when processing a Credential on File transaction

If the cardholder's credentials are being stored for the first time, and the issuer id was returned in the response, you must save the Issuer ID on your system to use in MIT subsequent Credential on File transactions

The IssuerID must be saved to your systems when returned from Moneris Gateway in the response data, regardless if the value was received or not. As a best practice, if the IssuerID is not returned and you received N/A instead, store it and send it in the subsequent transaction.

Vault Update Credit Card with Credential on File optional values

NOTE: Values for optional fields do not have to be sent in a transaction request, but the positional structure of CSV still requires the comma delimiters between each field regardless if a value is sent for the given field or not.

Value Type Limits Set method Description
Customer ID String 50-character alphanumeric cust_id This can be used for policy number, membership number, student ID, invoice number and so on.

This field is searchable from the Moneris Merchant Resource Centre.
Email address Phone Number 30-character alphanumeric email Email address of the customer. Can be sent in when creating or updating a Vault profile.
Phone Number String 30-character alphanumeric phone Phone number of the customer. Can be sent in when creating or updating a Vault profile.
Note String 30-character alphanumeric note This optional field can be used for supplementary information to be sent in with the transaction. This field can be sent in when creating or updating a Vault profile.
Credit card number String 20-character alphanumeric pan Most credit card numbers today are 16 digits, but some 13-digit numbers are still accepted by some issuers. This field has been intentionally expanded to 20 digits in consideration for future expansion and potential support of private label card ranges.
Expiry Date String 4-character alphanumeric (YYMM format) expdate Note: This is the reverse of the date displayed on the physical card, which is MMYY.
E-Commerce indicator String 1-character numeric crypt_type

Describes the category of e-commerce transaction being processed. Allowable values are:


  • 1 - Mail Order / Telephone Order—Single
  • 2 - Mail Order / Telephone Order—Recurring
  • 3 - Mail Order / Telephone Order—Instalment
  • 4 - Mail Order / Telephone Order—Unknown classification
  • 5 - Authenticated e-commerce transaction (VBV)
  • 6 - Non-authenticated e-commerce transaction (VBV)
  • 7 - SSL-enabled merchant

In Credential on File transactions where the request field e-commerce indicator is also being sent: the allowable values for e-commerce indicator are dependent on the value sent for payment indicator, as follows:


if payment indicator = R, then allowable values for e-commerce indicator: 2, 5 or 6
if payment indicator = C, then allowable values for e-commerce indicator: 1, 5, 6 or 7
if payment indicator = U, then allowable values for e-commerce indicator: 1 or 7
if payment indicator = Z, then allowable values for e-commerce indicator: 1, 5, 6 or 7

Vault Delete Credit Card

Deletes an existing Vault profile of any type using the unique data key that was assigned when the profile was added.

It is important to note that after a profile is deleted, the information which was saved within can no longer be retrieved.

Canada Code Sample

Request Format:

res_delete,order_id,data_key

Sample Request:

res_delete,mjr-res-delete-210510-251-1,E08TCqdXsiOhDey9YZDa7QDMa

Response Format:

order_id, reserved, ResponseCode, reserved, reserved, TransTime, TransDate, reserved, Complete, Message, reserved, reserved, reserved, TimedOut, reserved, reserved, data_key, payment_type, cust_id, phone, email, note, pan, exp_date, crypt_type, reserved, reserved, reserved, reserved

Sample Response:

mjr-res-delete-210510-251-1,null,001,null,null,14:53:13,2010-05-21,null,true,Successfully deleted CC details.,null,null,null,false,,,E08TCqdXsiOhDey9YZDa7QDMa,cc,moneris,phone,email,note,4242***4242,1111,7,, ,,

Vault Delete mandatory values

Value Type Limits Set method Description
Order ID String 50-character alphanumeric order_id For Vault administrative transactions, the order ID is used as a way to tie the request to the response. This field is not stored on file for future reference.
Data key String 25-character alphanumeric data_key Profile identifier that all future financial Vault transactions (that is, they occur after the profile was registered by a Vault Add Credit Card or Vault Tokenize Credit Card transaction, for example) will use to associate with the saved information.

The data key is generated by Moneris, and is returned to the merchant (via the Receipt object) when the profile is first registered.
Vault Response Fields
Value Limits Variable Description
Data Key 25-character alphanumeric DataKey This field is created when a profile is created and a token is returned.
It is a unique profile identifier, and is a required value for all future Vault transactions.
Vault Success true/false ResSuccess Indicates whether Vault transaction was successful.
PaymentType cc PaymentType Indicates the payment type associated with a Vault profile.
Customer ID 30-character alphanumeric cust_id Returns the customer ID saved in the profile.
Phone Number 30-character alphanumeric phone Returns the phone number saved in the profile.
Email Address 30-character alphanumeric email Returns the email address saved in the profile.
Note 30-character alphanumeric note Returns the note saved in the profile.
Credit Card Fields
Masked PAN 20-character numeric masked_pan Returns the first 4 last 4 of the card number saved in the profile.
Expiry Date 4-character numeric expdate Returns the expiry date of the card number saved in the profile. YYMM format.
E-Commerce Indicator 1-character numeric crypt_type Returns the e-commerce indicator saved in the profile.
AVS Street Number 19-character alphanumeric avs_street_number Returns the AVS street number saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Street Name 19-character alphanumeric avs_street_name Returns the AVS street name saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.
AVS Zip/Postal Code 9-character alphanumeric avs_street_zipcode Returns the AVS zip/postal code saved in the profile. If no other AVS street number is passed in the transaction request, this value will be submitted along with the financial transaction to the issuer.